home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Night Owl 6
/
Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso
/
026a
/
xref140c.zip
/
XREF.DOC
< prev
next >
Wrap
Text File
|
1991-01-30
|
14KB
|
374 lines
▀▀▀▀ ▀▀▀▀
▀▀▀ ▀▀▀
▀▀▀▀
▀▀ REF - Cross Reference Utility
▀▀▀▀ User Manual
▀▀▀ ▀▀▀ -----------
▀▀▀▀ ▀▀▀▀
Version 1.40c
copyright 1990, Jim Lynch
PURPOSE XREF is a data dictionary utility to provide both
online and printed documentation of your DBF
databases and indexes.
It also gives you the ability to add and update short
descriptions for each database field, an invaluable
documentation tool.
With the cross reference function, you can examine
the relationships between the databases and indexes.
XREF works with both NTX and NDX type indexes.
QUICK Start the program from the DOS prompt with the
START following syntax:
XREF /p<path> /f<dbfmask> /i<indexmask> /d /h
<path> is the drive:directory to search for
DBF's and indexes; the default is the
current directory.
<dbfmask> limits selection of DBF's to filenames
matching the mask; the default is all
DBF's.
<indexmask> limits selection of indexes to filenames
matching the mask; the default is all
indexes.
/d specifies .NDX type indexes; the default
is .NTX type indexes.
/h displays this syntax help.
All switches are optional, and can be entered in any
order, in either upper or lower case. For example, to
use all DBF's and NTX type indexes in current
directory, you would start the program without
switches:
XREF
To use NDX type indexes
XREF /d
To use DBF'S and NTX type indexes in the E:\MYDIR
path, and limit selection of DBF to those matching
the filespec CPI?????.DBF
XREF /pE:\MYDIR /fCPI
To use all DBF's and index matching the filespec
???tst??.NTX in \DB directory
XREF /i???tst /p\DB
ACTIVE PgUp - Scrolls the window up 1 page.
KEYS PgDn - Scrolls the window down 1 page.
Ctrl_PgUp - Moves to first item in the window.
Ctrl_PgDn - Moves to the last item in the window.
Ctrl_Cursor - Selects a new window.
Tab & Shift-Tab - " " " "
X - Searches for Cross-References to
the selected item. (see CROSS
REFERENCES, below).
SpaceBar - Tags/Untags items for reports. Tagged
items are marked with the √ character
R - Prints either the Database
Structure Report or the Index
Expression Report. First you must
select which databases and/or
indexes you wish to report on by
tagging them by pressing Spacebar.
Reports can be send to the
printer, or written to a file for
later printing or offline viewing.
E - Edits the Field Description. This
command is only active when you
are in the STRUCTURE window.
F1 - Pops up a help screen.
Esc - Quits to DOS.
CROSS There are 3 selectable windows: DBF WINDOW, the list
REFERENCES of dbfs; INDEX WINDOW, the list of indexes; and
STRUCTURE WINDOW, which shows the structure of the
selected dbf.
When cross-referencing is invoked, the result depends
on which window is active at the time, as follows:
Window Cross Reference function
--------- ---------------------------------------
DBF ALL INDEXES are searched for a string
matching any field in the SELECTED DBF.
Any INDEX with a matching string is
flagged with the marker.
INDEX ALL DBFs are searched for a field
contained in the SELECTED INDEX. Any
DBF with a matching string is flagged
with the marker.
STRUCTURE ALL INDEXES are searched for a string
matching the SELECTED FIELD. Any INDEX
with a matching string is flagged with
the marker.
Note that a cross reference between an index and a
database does not necessarily indicate that the files
are associated; it only indicates that the index
expression contains, as a string, one or more of the
dbf fields.
NETWORK XREF is network aware, and can be used while your
databases and indexes are in use on other
workstations. Multiple workstations may also run
XREF at the same time.
STRUCTURE To display database structures and maintain field
FILES descriptions, XREF creates a "structure" file for
each of your DBFs. These files have the same name as
the DBF, and the extension ".STR"
When XREF is started, it checks each DBF, and where
necessary creates or updates the "structure" file.
Each index is also read during program startup. In
this way the information displayed is always kept
current.
The first time XREF is run for a particular
directory, these files have to be created from
scratch, and so program initialization will take
somewhat longer, depending on how many dbf's you
have, and the speed of your machine.
TEMPORARY Four temporary files are created by XREF, and are
FILES normally deleted before you quit. If an abnormal
termination occurs, these files may be left behind;
it is ok to delete them. They are $newstr.dbf,
$tmpstr.dbf, $tmp2str.ntx, and $tmpidx.ntx.
WARNING Do not rename XREF.EXE, or attempt to compress it
with programs such as LZEXE or PKLITE. XREF will
not run under these circumstances.
LANGUAGE XREF is written almost entirely in Clipper, with the
exception of two assembly language functions to
determine the current drive, and to report the
date/time stamp of files.
FILES XREF.EXE
SUPPLIED: XREF.DOC
ABSTRACT.TXT
ORDER.DOC
SUPPORT: I can be reached via modem in the following ways:
FidoNet 1:278/627, NMH only.
conferences: Clipper,dBase,
Shareware
RelayNet (RIME) conferences: Clipper, dBase,
Shareware
InterLink (ILink) conferences: Clipper, dBase,
Shareware
SmartNet conferences: Clipper, dBase.
Moondog BBS main board, (718) 692-2498
Compuserv 71210,2354
By U.S. mail:
P.O. Box 140192
Staten Island, NY 10314
REVISION 4/10/90 - v1.00 original release
HISTORY:
6/02/90 - v1.10
- added ability to maintain a field
description for dbf fields
- added ability to specify path from the
command line
- added help screen
- enhanced appearance
- fixed incorrect index window ID's
6/20/90 - v1.20
- added report function
8/16/90 - v1.30
- added /f and /i switches to limit indexes and
dbf's displayed
- tags for reports and tags for cross
references can now be on the screen at the
same time
9/15/90 - v1.40
- startup time reduced by removing unnecessary
rebuilding of .STR files
- put help in movable, resizeable window
12/05/90 - v1.40a
- now indentify "Unique" indexes
- couldn't find NDX in same directory as XREF - fixed
- NDX report didn't paginate correctly - fixed
01/19/90 - v1.40b
- field descriptions lost if structure of DBF
was modified - fixed.
01/19/90 - v1.40c
- enhanced processing of errors returned from linker
- could not register program on network drive - fixed
REGISTER XREF is a Shareware program.
You are free to copy and distribute XREF for
NONCOMMERCIAL use provided it is not modified in any
way, and this document accompanies the program.
Clubs, user groups and disk distributors may charge a
nominal fee not to exceed $6 for expenses and
handling.
Shareware isn't free; it is a distribution method
that gives you a chance to try software before buying
it. If you try a Shareware program and continue using
it, you are expected to register.
The registration fee for XREF is $15.00 per copy,
which entitles you to lifetime technical support,
upgrade notices, and one free upgrade to the next
release. Registered copies also have the advertising
screen removed.
To register, simply fill out the form below, or in
the separate ORDER.DOC file.
OTHER Also available is HDBCALC, a memory-resident
PRODUCTS programmer's calculator that performs math and logical
operations in Hex, Decimal and Binary. I also plan to
release a Clipper function library sometime in the
future.
DISCLAIMER The author makes no warranties, expressed or implied,
including, but not limited to, merchantability or
fitness for any particular purpose. In no event
shall the author be liable for indirect or
consequential damages arising from the use of the
XREF.
XREF version 1.40c Order Form and Software License
---------------------------------------------------------------------
Use this form to register XREF. Each copy purchased entitles you to
exclusive use of XREF on a single computer. On local area networks,
for each copy purchased, only one copy of XREF may be in use at any
given time.
Registration also entitles you to lifetime technical support, notices
of upgrades, and one free upgrade to the next release. Registered
copies also have the advertising screen removed.
Volume Discounts, Site Licenses for ten or more users are also
available; please contact the author. Make checks payable to:
Jim Lynch
P.O. Box 140192
Staten Island, NY 10314
USA
You can also order directly from the Public (software) Library with
your MC, Visa, AmEx or Discover card by calling 800-2424-PsL or
713-524-6394 or by FAX to 713-524-6398 or by CompuServe to 71355,460
or by mail to P.O. Box 35705, Houston, Texas 77235-5705. These
numbers are for ordering only. For information about dealer pricing,
volume discounts, site licensing, shipping of product, returns,
latest version number or other technical information, please
contact the author as outlined under "SUPPORT" in the documentation.
*************************** PLEASE PRINT ***************************
___ copies @ $15 ea..................................... $______
Name____________________________________________________________
Company____________________________________________________________
Address____________________________________________________________
____________________________________________________________
Phone____________________________________________________________
Where did you obtain XREF 1.40c ? (Please check one)
BBS_____ Catalog_____ Other?____
Catalogue or BBS Name______________________________________________
Comments___________________________________________________________
__________________________________________________________
__________________________________________________________
__________________________________________________________